Feat/base skeleton #1

amimart · 2024-08-07T12:49:31Z

This PR brings preliminary design skeleton to the SDK, nothing functional. the intent is to setup a base on interfaces.

🗂️ Structure

Find below details on the different go modules:

├── auth        # Content related to the authentication of identities against the protocol in a generic way.
│   └── jwt     # Content related to the management of identities through JWT tokens.
├── dataverse   # Contains client elements to interact with the dataverse.
├── http        # Carry an http server configurable enough to simply build http connectors for services.
├── keys        # Carry the logic related to cryptographic keys.
└── provider    # Contains the logic associated with different types of resources providing services (e.g. storage, computation, etc...).
    └── storage # Implement an extensible storage service proxy, providing the base implementation allowing to customise the underlying logic.

🌐 Main components

`auth.Proxy`

A generic component to authenticate an identity given a signed credential, exposing a single Authenticate func. The idea is to be agnostic on the way the authentication is served (e.g. rest, gRPC...) and carry here only the business logic. the jwt.Factory can use it to issue JWT tokens and provide configuration elements to issue and verify jwt tokens on an http server.

`storage.Proxy`

A component to implement storage service proxies, taking care of all the generic tasks:

Authentication through auth.Proxy
Authorization on read & store requests

The specific logic to implement with an S3 for example is achieved by providing related functions when instantiating it.

It is also agnostic to the transport layer in its implementation, it offers configuration elements for an http server but could eventually be exposed in a different way.

`dataverse.Client`

Provide interactions with the protocol with a business logic dataverse oriented.

`http.Server`

An http server intended to be configured directly by proxy implementation to be served over http.

📺 Example

Here is an example of a storage connector implementation using these:

ctx := context.Background()
var dataverseClient dataverse.Client
serviceKeys, _ := keys.NewKeyFromMnemonic("")

storageProxy, _ := storage.NewProxy(
    ctx,
    serviceKeys,
    dataverseClient,
    func(ctx context.Context, resourceID string) (io.Reader, error) {
        // Implement specific read logic here
        return bytes.NewReader([]byte("resource data")), nil
    },
    func(ctx context.Context, resourceID string, data io.Reader) error {
        // Implement specific store logic here
        return nil
    },
)

axonehttp.NewServer(
    "0.0.0.0:8080",
    storageProxy.HTTPConfigurator([]byte("jwt_secret_key"), 5*time.Minute),
).Listen()

🙈 Missing

There is currently no canonical error handling here.

SSI & verifiable credentials management are also not covered currently.

❓Remarks

@ccamel @bdeneux Let's challenge everything, structure, naming, etc..

Some methods are pre-implemented to give an idea of their scopes.

coderabbitai · 2024-08-07T12:49:37Z

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces significant enhancements to an authentication framework, including new structures and functionalities for handling JWT (JSON Web Tokens) and managing decentralized identities. Key additions encompass an Identity struct for representing authenticated users, a Proxy interface for authentication via verifiable credentials, and various HTTP handlers for managing requests. The update also refines the project's documentation and configuration files, ensuring that unnecessary files are ignored during version control.

Changes

File(s)	Change Summary
`.gitignore`	Added entries for `target/`, `.idea/`, and `.DS_Store` to prevent unnecessary files from being tracked.
`README.md`	Updated project name to "axone-sdk" and modified lint badge URL.
`auth/http.go`, `auth/identity.go`, `auth/jwt/...`, `auth/proxy.go`	Introduced new files and types for authentication, JWT claims, and proxy management.
`dataverse/client.go`	Added `Client` interface for interacting with governance commands.
`http/server.go`	Created an HTTP server structure using Gorilla Mux router.
`keys/key.go`	Defined a `Key` struct for cryptographic key management.
`provider/storage/http.go`, `provider/storage/proxy.go`	Added HTTP handling functionalities and proxy management for resource access.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant AuthService
    participant Proxy
    participant Storage

    Client->>Server: HTTP Request
    Server->>AuthService: Authenticate
    AuthService-->>Server: Identity
    Server->>Proxy: Authenticate with Identity
    Proxy-->>Server: Authorization Result
    Server->>Storage: Access Resource
    Storage-->>Server: Resource Data
    Server-->>Client: HTTP Response

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

bdeneux

Seems very good ! I don't see any remarks about structure or naming. I think we will do some adjustment during implementation but that seems good. Good job 👍

provider/storage/http.go

ccamel

Seems good! Let's go.

amimart · 2024-08-09T07:11:18Z

Let's begin with that then :)

amimart added 6 commits August 7, 2024 14:43

chore: update gitignore

42f0574

docs: untemplate readme

06d83da

feat: design a http server with easy route configuration

7b7dd89

feat: add simple cryptographic key management

42b57d4

feat: setup dataverse client dummy interface

51347fa

feat: design authentication proxy elements

90c79be

amimart self-assigned this Aug 7, 2024

amimart requested review from ccamel and bdeneux August 7, 2024 13:20

amimart added 4 commits August 7, 2024 16:04

feat: design storage service proxy

cd4d012

feat: pre implement jwt management

b531ed6

feat: add storage proxy http configuration

f5736f6

chore: update deps

ba0c9ce

bdeneux approved these changes Aug 8, 2024

View reviewed changes

provider/storage/http.go Outdated Show resolved Hide resolved

ccamel approved these changes Aug 8, 2024

View reviewed changes

refactor: make it look better

11c7f16

amimart force-pushed the feat/base-skeleton branch from 36e93d1 to 11c7f16 Compare August 9, 2024 07:10

amimart marked this pull request as ready for review August 9, 2024 07:10

amimart merged commit c177d58 into main Aug 9, 2024
6 checks passed

amimart deleted the feat/base-skeleton branch August 9, 2024 07:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/base skeleton #1

Feat/base skeleton #1

amimart commented Aug 7, 2024 •

edited

Loading

coderabbitai bot commented Aug 7, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

bdeneux left a comment

ccamel left a comment

amimart commented Aug 9, 2024

Feat/base skeleton #1

Feat/base skeleton #1

Conversation

amimart commented Aug 7, 2024 • edited Loading

🗂️ Structure

🌐 Main components

auth.Proxy

storage.Proxy

dataverse.Client

http.Server

📺 Example

🙈 Missing

❓Remarks

coderabbitai bot commented Aug 7, 2024 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

bdeneux left a comment

Choose a reason for hiding this comment

ccamel left a comment

Choose a reason for hiding this comment

amimart commented Aug 9, 2024

amimart commented Aug 7, 2024 •

edited

Loading

`auth.Proxy`

`storage.Proxy`

`dataverse.Client`

`http.Server`

coderabbitai bot commented Aug 7, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)